Package com.cisco.pt.ipc.sim.impl
Class PTPClockImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.PTPClockImpl
Information provided by the PKI file:
\class PTPClock
\brief This file holds CPTPClock class declaration
\example network().getDevice("Switch0").getProcess("CPTPProcess").getClock();
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionPTPClockImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionvoidInformation provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:getMode()Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:voidinit()Information provided by the PKI file:voidsetDelayMechanism(DelayMechanism delay) Information provided by the PKI file:voidInformation provided by the PKI file:voidsetPriority1(int val) Information provided by the PKI file:voidsetPriority2(int val) Information provided by the PKI file:voidsetProfile(PTPProfile profile) Information provided by the PKI file:voidsetPtpTime(String time) Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
PTPClockImpl
public PTPClockImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
setMode
Information provided by the PKI file:
\brief Sets the mode. \param mode, the type of timer. Timer types: eE2etransparent = 0, eBoundary = 1, eForward = 2 -
getMode
Information provided by the PKI file:
\brief Returns the mode. \return PTPMode, the modes. Mode types: eE2etransparent = 0, eBoundary = 1, eForward = 2 -
getModeStr
Information provided by the PKI file:
\brief Returns the mode as a string. \return string, Mode strings: "e2etransparent", "boundary", "forward"- Specified by:
getModeStrin interfacePTPClock- Returns:
- String Returns a String
-
getNumOfPorts
public int getNumOfPorts()Information provided by the PKI file:
\brief Returns the number of ports. \return int, the number of ports.- Specified by:
getNumOfPortsin interfacePTPClock- Returns:
- int Returns a int
-
setProfile
Information provided by the PKI file:
\brief Sets the profile type. \param profile, the type of timer. Timer types: eDefault = 0, ePower = 1- Specified by:
setProfilein interfacePTPClock- Parameters:
profile- Takes in a parameter of profile
-
getProfile
Information provided by the PKI file:
\brief Gets the profile type. \return PTPProfile, the profile type. Timer types: eDefault = 0, ePower = 1- Specified by:
getProfilein interfacePTPClock- Returns:
- PTPProfile Returns a PTPProfile
-
getProfileStr
Information provided by the PKI file:
\brief Returns the profile as a string. \return string, profile strings: "Default", "Power"- Specified by:
getProfileStrin interfacePTPClock- Returns:
- String Returns a String
-
setDelayMechanism
Information provided by the PKI file:
\brief Sets the delay mechanism type. \param delay, the type of delay. Timer types: eEnd2End = 0, ePeer2Peer = 1- Specified by:
setDelayMechanismin interfacePTPClock- Parameters:
delay- Takes in a parameter of delay
-
getDelayMechanism
public int getDelayMechanism()Information provided by the PKI file:
\brief Gets the profile type. \return int, the profile type. Timer types: eDefault = 0, ePower = 1- Specified by:
getDelayMechanismin interfacePTPClock- Returns:
- int Returns a int
-
getDelayMechanismStr
Information provided by the PKI file:
\brief Returns the delay mechanisim as a string. \return string, profile strings: "End to End", "Peer to Peer"- Specified by:
getDelayMechanismStrin interfacePTPClock- Returns:
- String Returns a String
-
setPriority1
public void setPriority1(int val) Information provided by the PKI file:
\brief Sets priority 1 to the given value. \param val, value to use.- Specified by:
setPriority1in interfacePTPClock- Parameters:
val- Takes in a parameter of val
-
setPriority2
public void setPriority2(int val) Information provided by the PKI file:
\brief Sets priority 2 to the given value. \param val, value to use.- Specified by:
setPriority2in interfacePTPClock- Parameters:
val- Takes in a parameter of val
-
setPtpTime
Information provided by the PKI file:
\brief Sets ptp time to the given value. \param time, time to use.- Specified by:
setPtpTimein interfacePTPClock- Parameters:
time- Takes in a parameter of time
-
clearConfig
public void clearConfig()Information provided by the PKI file:
\brief Clears the config.- Specified by:
clearConfigin interfacePTPClock
-
init
public void init()Information provided by the PKI file:
\brief Runs the init setup.
-